<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>PaleGem: IRenderableObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PaleGem
   &#160;<span id="projectnumber">0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_i_renderable_object-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">IRenderableObject Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Renderable objects interface.  
 <a href="class_i_renderable_object.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_i_renderable_object_8h_source.html">IRenderableObject.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IRenderableObject:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_i_renderable_object.png" usemap="#IRenderableObject_map" alt=""/>
  <map id="IRenderableObject_map" name="IRenderableObject_map">
<area href="classpg_primitive_cube.html" alt="pgPrimitiveCube" shape="rect" coords="0,56,128,80"/>
<area href="classpg_primitive_triangle.html" alt="pgPrimitiveTriangle" shape="rect" coords="138,56,266,80"/>
<area href="classpg_renderable_object.html" title="The default renderable object." alt="pgRenderableObject" shape="rect" coords="276,56,404,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8617f0f0fe197a0bfd3939476ba03aad"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a8617f0f0fe197a0bfd3939476ba03aad">~IRenderableObject</a> ()</td></tr>
<tr class="separator:a8617f0f0fe197a0bfd3939476ba03aad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69fb217e1529b5ae33107d256f20f9e9"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a69fb217e1529b5ae33107d256f20f9e9">Load</a> (const char *szFilePath)=0</td></tr>
<tr class="memdesc:a69fb217e1529b5ae33107d256f20f9e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a mesh from the specified filepath.  <a href="#a69fb217e1529b5ae33107d256f20f9e9">More...</a><br/></td></tr>
<tr class="separator:a69fb217e1529b5ae33107d256f20f9e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a527206d091af2f65837cd7bb83a7ddcb"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a527206d091af2f65837cd7bb83a7ddcb">Load</a> ()=0</td></tr>
<tr class="memdesc:a527206d091af2f65837cd7bb83a7ddcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for primitive derived objects.  <a href="#a527206d091af2f65837cd7bb83a7ddcb">More...</a><br/></td></tr>
<tr class="separator:a527206d091af2f65837cd7bb83a7ddcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9eb9acb43b22ec1a60b570630afaebf5"><td class="memItemLeft" align="right" valign="top">virtual XMMATRIX&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a9eb9acb43b22ec1a60b570630afaebf5">GetWorldTransformMatrix</a> ()=0</td></tr>
<tr class="separator:a9eb9acb43b22ec1a60b570630afaebf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001ef1f9df8f5ff46f25b16b5e4f1538"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a001ef1f9df8f5ff46f25b16b5e4f1538">SetWorldTransformMatrix</a> (XMMATRIX mat)=0</td></tr>
<tr class="separator:a001ef1f9df8f5ff46f25b16b5e4f1538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1137c257fc196fda57f81d9e8a08a40f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a1137c257fc196fda57f81d9e8a08a40f">Render</a> ()=0</td></tr>
<tr class="memdesc:a1137c257fc196fda57f81d9e8a08a40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function needs to take care of rendering the object.  <a href="#a1137c257fc196fda57f81d9e8a08a40f">More...</a><br/></td></tr>
<tr class="separator:a1137c257fc196fda57f81d9e8a08a40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17f8490e4248b2e86f80c096eb8b5061"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#a17f8490e4248b2e86f80c096eb8b5061">PreRender</a> ()=0</td></tr>
<tr class="memdesc:a17f8490e4248b2e86f80c096eb8b5061"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called immmediately before <a class="el" href="class_i_renderable_object.html#a1137c257fc196fda57f81d9e8a08a40f" title="This function needs to take care of rendering the object.">Render()</a>.  <a href="#a17f8490e4248b2e86f80c096eb8b5061">More...</a><br/></td></tr>
<tr class="separator:a17f8490e4248b2e86f80c096eb8b5061"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc15b8342715b37a63cbfe65d1f28301"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_renderable_object.html#acc15b8342715b37a63cbfe65d1f28301">PostRender</a> ()=0</td></tr>
<tr class="memdesc:acc15b8342715b37a63cbfe65d1f28301"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called immediately after <a class="el" href="class_i_renderable_object.html#a1137c257fc196fda57f81d9e8a08a40f" title="This function needs to take care of rendering the object.">Render()</a>.  <a href="#acc15b8342715b37a63cbfe65d1f28301">More...</a><br/></td></tr>
<tr class="separator:acc15b8342715b37a63cbfe65d1f28301"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Renderable objects interface. </p>
<p>This is the objecttype the renderer uses to iterate through the object to be renderered </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8617f0f0fe197a0bfd3939476ba03aad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual IRenderableObject::~IRenderableObject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9eb9acb43b22ec1a60b570630afaebf5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual XMMATRIX IRenderableObject::GetWorldTransformMatrix </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="classpg_renderable_object.html#ae8b043753092952bf012283460eeae3a">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#af685031c1b657bb9b89d34ab47d3f795">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#a059838a96c6f28fbc37395014ad97abd">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<a class="anchor" id="a69fb217e1529b5ae33107d256f20f9e9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool IRenderableObject::Load </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szFilePath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Loads a mesh from the specified filepath. </p>
<p>The format is chosen by the extension </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">szFilePath</td><td>Path to the mesh file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>

<p>Implemented in <a class="el" href="classpg_renderable_object.html#a11ccb575b1ecc1dcd0e641d985a0e29c">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#a3231d83c2a689104b60887a1424989d4">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#a05115ba29d5f6c99247d6b94bdce5169">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<a class="anchor" id="a527206d091af2f65837cd7bb83a7ddcb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool IRenderableObject::Load </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used for primitive derived objects. </p>

<p>Implemented in <a class="el" href="classpg_renderable_object.html#ad0293f0e6bf59fa5344f94a96e65ea26">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#a7f3966bb05ba1fd8eb7420200c818ae6">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#a12dda0b886c4517bcacfe03a9f4d3a1d">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<a class="anchor" id="acc15b8342715b37a63cbfe65d1f28301"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IRenderableObject::PostRender </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called immediately after <a class="el" href="class_i_renderable_object.html#a1137c257fc196fda57f81d9e8a08a40f" title="This function needs to take care of rendering the object.">Render()</a>. </p>

<p>Implemented in <a class="el" href="classpg_renderable_object.html#a0c09b82c6c02f8c5b071b5f41d8db762">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#a8135664cb28bb45001bc0143a4dc8c47">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#ac5ff42565006a0aaaf5938129b58b17a">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<a class="anchor" id="a17f8490e4248b2e86f80c096eb8b5061"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IRenderableObject::PreRender </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called immmediately before <a class="el" href="class_i_renderable_object.html#a1137c257fc196fda57f81d9e8a08a40f" title="This function needs to take care of rendering the object.">Render()</a>. </p>

<p>Implemented in <a class="el" href="classpg_renderable_object.html#a5a88dd638276dbd1f812aa1940e619d3">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#a03b221ea37fdd7f0b647255a32822598">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#a4dfa93d20b8e77718b2db55557660284">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<a class="anchor" id="a1137c257fc196fda57f81d9e8a08a40f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IRenderableObject::Render </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function needs to take care of rendering the object. </p>
<p>Setting up data relevant to rendering should be performed in <a class="el" href="class_i_renderable_object.html#a17f8490e4248b2e86f80c096eb8b5061" title="Called immmediately before Render().">PreRender()</a>. </p>

<p>Implemented in <a class="el" href="classpg_renderable_object.html#a6f88d861da386efdb201dd1497460049">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#a450666fe0d2441c32a2de007bce5b30d">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#a10d741e8d9c2bafcaa6e119c34fc4606">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<a class="anchor" id="a001ef1f9df8f5ff46f25b16b5e4f1538"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void IRenderableObject::SetWorldTransformMatrix </td>
          <td>(</td>
          <td class="paramtype">XMMATRIX&#160;</td>
          <td class="paramname"><em>mat</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="classpg_renderable_object.html#a3b37315c868aa9662fabd08e4b185cd3">pgRenderableObject</a>, <a class="el" href="classpg_primitive_cube.html#a1fb52b00d40fb1d1465a8e6e3faf706e">pgPrimitiveCube</a>, and <a class="el" href="classpg_primitive_triangle.html#a604a83ba51db557f8786a2d9ecb897b6">pgPrimitiveTriangle</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Inc/<a class="el" href="_i_renderable_object_8h_source.html">IRenderableObject.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 1 2013 11:55:07 for PaleGem by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
